/*
 * $Id: bfd.h,v 1.5.2.10 Broadcom SDK $
 * 
 * $Copyright: Copyright 2011 Broadcom Corporation.
 * This program is the proprietary software of Broadcom Corporation
 * and/or its licensors, and may only be used, duplicated, modified
 * or distributed pursuant to the terms and conditions of a separate,
 * written license agreement executed between you and Broadcom
 * (an "Authorized License").  Except as set forth in an Authorized
 * License, Broadcom grants no license (express or implied), right
 * to use, or waiver of any kind with respect to the Software, and
 * Broadcom expressly reserves all rights in and to the Software
 * and all intellectual property rights therein.  IF YOU HAVE
 * NO AUTHORIZED LICENSE, THEN YOU HAVE NO RIGHT TO USE THIS SOFTWARE
 * IN ANY WAY, AND SHOULD IMMEDIATELY NOTIFY BROADCOM AND DISCONTINUE
 * ALL USE OF THE SOFTWARE.  
 *  
 * Except as expressly set forth in the Authorized License,
 *  
 * 1.     This program, including its structure, sequence and organization,
 * constitutes the valuable trade secrets of Broadcom, and you shall use
 * all reasonable efforts to protect the confidentiality thereof,
 * and to use this information only in connection with your use of
 * Broadcom integrated circuit products.
 *  
 * 2.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS
 * PROVIDED "AS IS" AND WITH ALL FAULTS AND BROADCOM MAKES NO PROMISES,
 * REPRESENTATIONS OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY,
 * OR OTHERWISE, WITH RESPECT TO THE SOFTWARE.  BROADCOM SPECIFICALLY
 * DISCLAIMS ANY AND ALL IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY,
 * NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF VIRUSES,
 * ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
 * CORRESPONDENCE TO DESCRIPTION. YOU ASSUME THE ENTIRE RISK ARISING
 * OUT OF USE OR PERFORMANCE OF THE SOFTWARE.
 * 
 * 3.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO EVENT SHALL
 * BROADCOM OR ITS LICENSORS BE LIABLE FOR (i) CONSEQUENTIAL,
 * INCIDENTAL, SPECIAL, INDIRECT, OR EXEMPLARY DAMAGES WHATSOEVER
 * ARISING OUT OF OR IN ANY WAY RELATING TO YOUR USE OF OR INABILITY
 * TO USE THE SOFTWARE EVEN IF BROADCOM HAS BEEN ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES; OR (ii) ANY AMOUNT IN EXCESS OF
 * THE AMOUNT ACTUALLY PAID FOR THE SOFTWARE ITSELF OR USD 1.00,
 * WHICHEVER IS GREATER. THESE LIMITATIONS SHALL APPLY NOTWITHSTANDING
 * ANY FAILURE OF ESSENTIAL PURPOSE OF ANY LIMITED REMEDY.$
 */

#ifndef __BCM_INT_BFD_H__
#define __BCM_INT_BFD_H__

#if defined(INCLUDE_L3)

#include <bcm/bfd.h>
#include <shared/shr_resmgr.h>

#define BFD_THREAD_PRI_DFLT     200

extern int bcm_esw_bfd_lock(int unit);
extern int bcm_esw_bfd_unlock(int unit);
#ifdef BCM_WARM_BOOT_SUPPORT
extern int _bcm_esw_bfd_sync(int unit);
#endif
#ifdef BCM_WARM_BOOT_SUPPORT_SW_DUMP
extern void _bcm_bfd_sw_dump(int unit);
#endif /* BCM_WARM_BOOT_SUPPORT_SW_DUMP */

typedef struct _bcm_bfd_endpoint_s
{
    int endpoint_index;
    int32 glp;
    int l2l3l4_offset;
    int l2l3l4_length;
    int l2l3l4_type;
    int mep_offset;
    bcm_bfd_endpoint_info_t info;
} _bcm_bfd_endpoint_t;

typedef struct _bcm_bfd_event_handler_s
{
    struct _bcm_bfd_event_handler_s *next_p;
    bcm_bfd_event_types_t event_types;
    bcm_bfd_event_cb cb;
    void *user_data;
} _bcm_bfd_event_handler_t;

typedef struct _bcm_bfd_info_s
{
    int unit;
    int initialized;
    int endpoint_count;
    int bte_num;
    int dma_num;
    int num_auth_sha1_key;
    int num_auth_sp_key;
    int encap_size;
    shr_mres_handle_t res_mgr;
    uint8* dmabuf_req;
    uint8* dmabuf_reply;
    SHR_BITDCL *endpoints_in_use;
    _bcm_bfd_endpoint_t *endpoints;
    _bcm_bfd_event_handler_t *event_handler_list_p;
    bcm_bfd_auth_sha1_t *auth_sha1;
    bcm_bfd_auth_simple_password_t *auth_sp;
    sal_thread_t bfd_tid;
} _bcm_bfd_info_t;

#endif /* INCLUDE_L3 */
#endif /* !__BCM_INT_BFD_H__ */
